<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/base/connectionManager/NicEntry.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00250.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">NicEntry.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        NicEntry.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Daniel Willkomm</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * copyright:   (C) 2005 Telecommunication Networks Group (TKN) at</span>
<a name="l00007"></a>00007 <span class="comment"> *              Technische Universitaet Berlin, Germany.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> *              This program is free software; you can redistribute it</span>
<a name="l00010"></a>00010 <span class="comment"> *              and/or modify it under the terms of the GNU General Public</span>
<a name="l00011"></a>00011 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00012"></a>00012 <span class="comment"> *              version 2 of the License, or (at your option) any later</span>
<a name="l00013"></a>00013 <span class="comment"> *              version.</span>
<a name="l00014"></a>00014 <span class="comment"> *              For further information see file COPYING</span>
<a name="l00015"></a>00015 <span class="comment"> *              in the top level directory</span>
<a name="l00016"></a>00016 <span class="comment"> ***************************************************************************</span>
<a name="l00017"></a>00017 <span class="comment"> * part of:     framework implementation developed by tkn</span>
<a name="l00018"></a>00018 <span class="comment"> * description: Class to store information about a nic for the</span>
<a name="l00019"></a>00019 <span class="comment"> *              ConnectionManager module</span>
<a name="l00020"></a>00020 <span class="comment"> **************************************************************************/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef NICENTRY_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define NICENTRY_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;omnetpp.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;map&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;Coord.h&quot;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="a00053.html" title="Basic class for all physical layers, please don&#39;t touch!!">ConnectionManagerAccess</a>;
<a name="l00032"></a>00032 
<a name="l00041"></a><a class="code" href="a00159.html">00041</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a> : <span class="keyword">public</span> cObject
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043   <span class="keyword">public</span>:
<a name="l00045"></a><a class="code" href="a00159.html#ae9ce6e70f7231c299aac66e4cde88671">00045</a>   <span class="keyword">typedef</span> <span class="keywordtype">int</span>     <a class="code" href="a00159.html#ae9ce6e70f7231c299aac66e4cde88671" title="Type for NIC identifier.">t_nicid</a>;
<a name="l00046"></a>00046   <span class="keyword">typedef</span> <a class="code" href="a00159.html#ae9ce6e70f7231c299aac66e4cde88671" title="Type for NIC identifier.">t_nicid</a> t_nicid_cref;
<a name="l00047"></a>00047 
<a name="l00049"></a><a class="code" href="a00160.html">00049</a>   <span class="keyword">class </span><a class="code" href="a00160.html" title="Comparator class for NicEntry for usage in STL containers.">NicEntryComparator</a> {
<a name="l00050"></a>00050     <span class="keyword">public</span>:
<a name="l00051"></a>00051     <span class="keywordtype">bool</span> operator() (<span class="keyword">const</span> <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>* nic1, <span class="keyword">const</span> <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>* nic2)<span class="keyword"> const </span>{
<a name="l00052"></a>00052       <span class="keywordflow">return</span> nic1-&gt;<a class="code" href="a00159.html#a35ef2f3ace25220bf226c52b444d1109" title="module id of the nic for which information is stored">nicId</a> &lt; nic2-&gt;<a class="code" href="a00159.html#a35ef2f3ace25220bf226c52b444d1109" title="module id of the nic for which information is stored">nicId</a>;
<a name="l00053"></a>00053     }
<a name="l00054"></a>00054   };
<a name="l00055"></a>00055   <span class="keyword">public</span>:
<a name="l00057"></a><a class="code" href="a00159.html#a209882de7781ff52db0ae559c1654e08">00057</a>     <span class="keyword">typedef</span> std::map&lt;const NicEntry*, cGate*, NicEntryComparator&gt; <a class="code" href="a00159.html#a209882de7781ff52db0ae559c1654e08" title="Type for map from NicEntry pointer to a gate.">GateList</a>;
<a name="l00058"></a>00058 
<a name="l00060"></a><a class="code" href="a00159.html#a35ef2f3ace25220bf226c52b444d1109">00060</a>     <a class="code" href="a00159.html#ae9ce6e70f7231c299aac66e4cde88671" title="Type for NIC identifier.">t_nicid</a> <a class="code" href="a00159.html#a35ef2f3ace25220bf226c52b444d1109" title="module id of the nic for which information is stored">nicId</a>;
<a name="l00061"></a>00061 
<a name="l00063"></a><a class="code" href="a00159.html#af7819e950101d5062b713eb4c182e34f">00063</a>     cModule *<a class="code" href="a00159.html#af7819e950101d5062b713eb4c182e34f" title="Pointer to the NIC module.">nicPtr</a>;
<a name="l00064"></a>00064 
<a name="l00066"></a><a class="code" href="a00159.html#af474d9b383b959daecdecce577edcee9">00066</a>     <span class="keywordtype">int</span> <a class="code" href="a00159.html#af474d9b383b959daecdecce577edcee9" title="Module id of the host module this nic belongs to.">hostId</a>;
<a name="l00067"></a>00067 
<a name="l00069"></a><a class="code" href="a00159.html#a2c78b2c598d5fa3d44080f682adb8d83">00069</a>     <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a> <a class="code" href="a00159.html#a2c78b2c598d5fa3d44080f682adb8d83" title="Geographic location of the nic.">pos</a>;
<a name="l00070"></a>00070 
<a name="l00072"></a><a class="code" href="a00159.html#a684948749e06f0956cd1ef9fffdedd75">00072</a>     <a class="code" href="a00053.html" title="Basic class for all physical layers, please don&#39;t touch!!">ConnectionManagerAccess</a>* <a class="code" href="a00159.html#a684948749e06f0956cd1ef9fffdedd75" title="Points to this nics ConnectionManagerAccess module.">chAccess</a>;
<a name="l00073"></a>00073 
<a name="l00074"></a>00074   <span class="keyword">protected</span>:
<a name="l00076"></a><a class="code" href="a00159.html#af0a6ff3792dac4c0a956b1a16392cf18">00076</a>     <span class="keywordtype">bool</span> <a class="code" href="a00159.html#af0a6ff3792dac4c0a956b1a16392cf18" title="Debug output switch.">coreDebug</a>;
<a name="l00077"></a>00077 
<a name="l00085"></a><a class="code" href="a00159.html#a66b957327e66c042028f7b38e4bd0b46">00085</a>     <a class="code" href="a00159.html#a209882de7781ff52db0ae559c1654e08" title="Type for map from NicEntry pointer to a gate.">GateList</a> <a class="code" href="a00159.html#a66b957327e66c042028f7b38e4bd0b46" title="Outgoing connections of this nic.">outConns</a>;
<a name="l00086"></a>00086 
<a name="l00087"></a>00087   <span class="keyword">public</span>:
<a name="l00091"></a><a class="code" href="a00159.html#a59345a3d9d2a9c6b85ff968e87cf7552">00091</a>     <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>(<span class="keywordtype">bool</span> debug)
<a name="l00092"></a>00092       : cObject()
<a name="l00093"></a>00093       , nicId(0)
<a name="l00094"></a>00094       , nicPtr(NULL)
<a name="l00095"></a>00095       , hostId(0)
<a name="l00096"></a>00096       , pos()
<a name="l00097"></a>00097       , chAccess(NULL)
<a name="l00098"></a>00098       , coreDebug(debug)
<a name="l00099"></a>00099       , outConns()
<a name="l00100"></a>00100     { }
<a name="l00101"></a>00101 
<a name="l00102"></a>00102     <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>(<span class="keyword">const</span> <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>&amp; o)
<a name="l00103"></a>00103       : cObject(o)
<a name="l00104"></a>00104       , nicId(o.nicId)
<a name="l00105"></a>00105       , nicPtr(o.nicPtr)
<a name="l00106"></a>00106       , hostId(o.hostId)
<a name="l00107"></a>00107       , pos(o.pos)
<a name="l00108"></a>00108       , chAccess(o.chAccess)
<a name="l00109"></a>00109       , coreDebug(o.coreDebug)
<a name="l00110"></a>00110       , outConns(o.outConns)
<a name="l00111"></a>00111     { }
<a name="l00112"></a>00112 
<a name="l00113"></a>00113     <span class="keywordtype">void</span> swap(<a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>&amp; s)
<a name="l00114"></a>00114     {
<a name="l00115"></a>00115       std::swap(nicId, s.<a class="code" href="a00159.html#a35ef2f3ace25220bf226c52b444d1109" title="module id of the nic for which information is stored">nicId</a>);
<a name="l00116"></a>00116       std::swap(nicPtr, s.<a class="code" href="a00159.html#af7819e950101d5062b713eb4c182e34f" title="Pointer to the NIC module.">nicPtr</a>);
<a name="l00117"></a>00117       std::swap(hostId, s.<a class="code" href="a00159.html#af474d9b383b959daecdecce577edcee9" title="Module id of the host module this nic belongs to.">hostId</a>);
<a name="l00118"></a>00118       std::swap(pos, s.<a class="code" href="a00159.html#a2c78b2c598d5fa3d44080f682adb8d83" title="Geographic location of the nic.">pos</a>);
<a name="l00119"></a>00119       std::swap(chAccess, s.<a class="code" href="a00159.html#a684948749e06f0956cd1ef9fffdedd75" title="Points to this nics ConnectionManagerAccess module.">chAccess</a>);
<a name="l00120"></a>00120       std::swap(coreDebug, s.<a class="code" href="a00159.html#af0a6ff3792dac4c0a956b1a16392cf18" title="Debug output switch.">coreDebug</a>);
<a name="l00121"></a>00121       std::swap(outConns, s.<a class="code" href="a00159.html#a66b957327e66c042028f7b38e4bd0b46" title="Outgoing connections of this nic.">outConns</a>);
<a name="l00122"></a>00122     }
<a name="l00123"></a>00123 
<a name="l00124"></a>00124     <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>&amp; o)
<a name="l00125"></a>00125     {
<a name="l00126"></a>00126       nicId     = o.<a class="code" href="a00159.html#a35ef2f3ace25220bf226c52b444d1109" title="module id of the nic for which information is stored">nicId</a>;
<a name="l00127"></a>00127       nicPtr    = o.<a class="code" href="a00159.html#af7819e950101d5062b713eb4c182e34f" title="Pointer to the NIC module.">nicPtr</a>;
<a name="l00128"></a>00128       hostId    = o.<a class="code" href="a00159.html#af474d9b383b959daecdecce577edcee9" title="Module id of the host module this nic belongs to.">hostId</a>;
<a name="l00129"></a>00129       pos       = o.<a class="code" href="a00159.html#a2c78b2c598d5fa3d44080f682adb8d83" title="Geographic location of the nic.">pos</a>;
<a name="l00130"></a>00130       chAccess  = o.<a class="code" href="a00159.html#a684948749e06f0956cd1ef9fffdedd75" title="Points to this nics ConnectionManagerAccess module.">chAccess</a>;
<a name="l00131"></a>00131       coreDebug = o.<a class="code" href="a00159.html#af0a6ff3792dac4c0a956b1a16392cf18" title="Debug output switch.">coreDebug</a>;
<a name="l00132"></a>00132       outConns  = o.<a class="code" href="a00159.html#a66b957327e66c042028f7b38e4bd0b46" title="Outgoing connections of this nic.">outConns</a>;
<a name="l00133"></a>00133       <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00134"></a>00134     }
<a name="l00138"></a><a class="code" href="a00159.html#afd3d4871304939e9dcbfda49b3ca4585">00138</a>     <span class="keyword">virtual</span> <a class="code" href="a00159.html#afd3d4871304939e9dcbfda49b3ca4585" title="Destructor -- needs to be there...">~NicEntry</a>() {}
<a name="l00139"></a>00139 
<a name="l00141"></a>00141     <span class="keyword">virtual</span> <span class="keywordtype">void</span> connectTo(<a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>*) = 0;
<a name="l00142"></a>00142 
<a name="l00144"></a>00144     <span class="keyword">virtual</span> <span class="keywordtype">void</span> disconnectFrom(<a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>*) = 0;
<a name="l00145"></a>00145 
<a name="l00147"></a><a class="code" href="a00159.html#a4d455ea8504c06c9288f8a474c85e65d">00147</a>     <span class="keyword">const</span> <a class="code" href="a00159.html#a209882de7781ff52db0ae559c1654e08" title="Type for map from NicEntry pointer to a gate.">GateList</a>&amp; <a class="code" href="a00159.html#a4d455ea8504c06c9288f8a474c85e65d" title="return the actual gateList">getGateList</a>()<span class="keyword"> const </span>{
<a name="l00148"></a>00148       <span class="keywordflow">return</span> outConns;
<a name="l00149"></a>00149     }
<a name="l00150"></a>00150 
<a name="l00152"></a><a class="code" href="a00159.html#a32f9544fbf045d921b0fb7f1c6f51f9a">00152</a>     <span class="keywordtype">bool</span> <a class="code" href="a00159.html#a32f9544fbf045d921b0fb7f1c6f51f9a" title="Checks if this nic is connected to the &quot;other&quot; nic.">isConnected</a>(<span class="keyword">const</span> <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>* other) {
<a name="l00153"></a>00153         <span class="keywordflow">return</span> (outConns.find(other) != outConns.end());
<a name="l00154"></a>00154     }
<a name="l00155"></a>00155 
<a name="l00164"></a><a class="code" href="a00159.html#a9438df597dbc6f81c5c2407abb791f0b">00164</a>     <span class="keyword">const</span> cGate* <a class="code" href="a00159.html#a9438df597dbc6f81c5c2407abb791f0b">getOutGateTo</a>(<span class="keyword">const</span> <a class="code" href="a00159.html" title="NicEntry is used by ConnectionManager to store the necessary information for each nic...">NicEntry</a>* to)<span class="keyword"> const </span>{
<a name="l00165"></a>00165       <span class="keywordflow">return</span> outConns.at(to);
<a name="l00166"></a>00166     }
<a name="l00167"></a>00167 
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169 
<a name="l00170"></a>00170 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>NicEntry.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:29 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
